Tech Arsenal 1

home *** CD-ROM | disk | FTP | other *** search

/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / wwived23.zip / WWIVEDIT.DOC < prev next >

Wrap

Text File | 1992-04-19 | 20.5 KB | 529 lines

WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) OVERVIEW WWIVEdit is a full screen editor designed for WWIV 4.xx BBS system. WWIVEdit has many of the bells and whistles of a regular word processor, plus it supports some WWIV specific things, such as Colors, a Two-Way chat mode, and Macros. WWIVEdit is fairly "intelligent"; it can usually figure out where a message is going, and will print an appropriate header when it can. WWIVEdit is an evolving software product. It may never be complete, but its getting there. INSTALLATION INSTRUCTIONS WWIVEdit is very easy to install... In fact, it will install itself. All you have to do is unzip the distribution file into a temporary directory, and then type INSTALL. The install program will prompt you for your WWIV directory, and where you want to install WWIVEdit to, and then create the needed directory structure and copy the proper files into place. It will also configure the command lines correctly for you, so the only thing you have to do is make sure that you have a Logon event with %1 on the command line. If by some odd chance the Install program can't/doesn't get the command lines right, for reference, they are: Remote: C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4 Local: C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4 -key:local -set:local Assumming that your WWIV directory is C:\WWIV The install program for WWIVEdit will create the following directory structure: ───WWIV────WWIVEDIT───┬─CONFIG ├─DICT └─DOC The WWIVEDIT directory should contain: MACROS.LCL, NOTAG, TAGLINES.CMN, WWIVEDIT.EXE, WWIVEDIT.HLP, WWIVEDIT.KEY, and WWIVEDIT.OVR TAGLINES.CMN is created after the first run of WWIVEdit. The CONFIG directory should contain: LOCAL.DEF, LOCAL.KEY, DEFAULT.DEF, DEFAULT.KEY, ECLIPSE.DEF After the first run of WWIVEdit with a particular DEF and/or KEY file, new files will appear. For example, from LOCAL.DEF, LOCAL.SET will be created, and from LOCAL.KEY, LOCAL.KBD will created. These are the - 1 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) binary forms of the "text" files. They will be used the next time WWIVEdit is run to speed up loading. The DOC directory contains various files (such as this one). That's all you need for the standard configuration if you are running unmodified WWIV 4.xx, although, be sure to read the information about Logon Events below. You will also want to look at the accompanying files called CONFIG.DOC and KEY.DOC. They give a comprehensive discussion of configuring WWIVEdit to your system. If you have made any of the following changes to you BBS, you must install the EDITINFO.MOD (included with WWIVEdit) otherwise incorrect information will be displayed, and possibly confusion over taglines and some of the other advanced features of WWIVEdit. 1) Modified your read/main menu prompt to something that does not have a set of [] or <> around the message base name. 2) Modified any of the following "phrases", or changed the spacing of them in the BBS: "Title", "E-mail", "Post", "Multi-Mail", "Filename?" 3) You have added an option that allows a new user to select a full screen editor before the "validation feedback" 4) You do not have and do not want to create a Logon Event Even if none of these applies to you and you have the WWIV Source code, you are still strongly encouraged to install EDITINFO.MOD. LOGON EVENT ----------- For tag lines and user defaults to properly function, you must always have an up-to-date CHAIN.TXT file (or install EDITINFO.MOD). This file is updated when a user logs on if you have a logon event, so you need to create one if you do not yet have one. If you don't have one, or you are not sure, do the following: 1. Run INIT.EXE which came with WWIV. 2. Select Option #6 (External Programs) 3. Move down to Logon Event 4. If there is nothing there, enter LOGON.BAT %1. If there is something already there (and it has %1 on the command line), then you are all done. Otherwise see #5 5. Press ESC a few times to exit INIT.EXE, and then create a file called LOGON.BAT. It need not contain anything, just create it. A simple way to do this is to type COPY CON LOGON.BAT @Echo Welcome to <Insert BBS name here> [Enter] press Control-Z and then [Enter] EDITINFO.MOD ------------ EDITINFO.MOD is a modification that I wrote so that WWIVEdit can more effectively communicate with the BBS. EDITINFO.MOD communicates with the BBS through two different files. The first file is called EDITOR.INF. The BBS creates this file before invoking the editor. - 2 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) This file contains information about the messages's destination, title, and information about its author. The second file is created by WWIVEdit. This file contain the "Anonymous" state of the message just saved, and its title. Enhancements enabled by this modification: /TI : Title Change /ESN : Non-Anonymous save without that annoying Anonymous? prompt /ESY : Anonymous save without prompt "Title:" and "Dest:" will always be correct Fixes problems that appear under special situations (//CHUSER) Disadvantages: Slows down loading very slightly for full screen editors other than WWIVEdit. Requires that you have the BBS source code. MS-DOS 5.0 ---------- If you are running MS-DOS 5.0 and Wayne Bell's DOS 5.0 fix for WWIV 4.12, you need to do some additional work. Go into RETURN.C and search for ni_stack[100]. Change it to ni_stack[1024]. Next, search for &ni_stack[98] and change it to &ni_stack[1022]. Repeat these in EXTRN.C, and that should fix everything (including problems with other editors). TURBO C 2.0 ----------- I have heard that there is may be a problem if you compile WWIV using Turbo C 2.0. This may cause the editor to hang up your system. If you are having problems with lockups on your system, try installing a stock copy of WWIV 4.xx and see if WWIVEdit will work with it. If it doesn't, please let me know so I can correct the problem if possible. BACKSPACE/DELETE ---------------- WWIV 4.xx has a "bug" that causes the delete key to be mapped as the backspace key. What that means is that from remote, when the user presses his delete key expecting the character under the cursor to be deleted, the editor will instead delete the character to the left of the cursor. The EDITINFO.MOD included with WWIVEdit has a few steps in it that will fix this bug for all external editors, without affecting other externals or the internal WWIV editor. USER MACROS ----------- User Macros are once again External to WWIVEdit. To define a macro, you must go into the defaults section of the BBS and select "Update Macros". From there you will choose Make, and then select either the Control-A, Control-D, or Control-F macro. If user macros are not working correctly, modify the KEYBOARD parameter in the DEF file. - 3 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) LOCAL MACROS ------------ Some sysops commented to me that they would like ALT-1 thru ALT-0 macros. I took this to the extreme and allowed not only those, but also Alt-F1 thru Alt-F10, Ctrl-F1 thru Ctrl-F10, Shift-F1 thru Shift- F10, Alt-A thru Alt-Z, and F1 thru F10. So... If anyone needs more than 10 macros, they can have them. Each macro is limited to approximately 1000 characters. If anyone requires more than this for a single macro, just say so, and I will increase it for you. Local macros are stored in a file called MACROS.LCL which is a text file that can be edited with WWIVEdit. An example file is provided with the editor. This file, along with WWIVEDIT.KEY must be in your WWIVEDIT directory. You must also have WWIVEDITMACROS set to 1 in the DEF file that you are using (LOCAL.DEF). To specify a macro in it, you have to first figure out what the "name" of it is. The following naming conventions are used: "A" thru "Z" relate to Alt-A thru Alt-Z "1" thru "0" relate to Alt-1 thru Alt-0 "F1" thru "F0" relate to F1 thru F10 "$F1" thru "$F0" relate to Shift-F1 thru Shift-F10 "^F1" thru "^F0" relate to Control-F1 thru Control-F10 "!F1" thru "!F0" relate to Alt-F1 thru Alt-F10 ^IN and $IN are Control Insert and Shift Insert ^DL and $DL are Control Delete and Shift Delete $TB is Shift Tab HOM is the Home Key END is the End Key UP, RT, LF, and DN are the Arrow keys Up, Right, Left, and Down PU and PD are Page Up and Page Down INS and DEL are the insert and delete keys ^LF and ^RT are Control Left Arrow and Control Right Arrow ^PU and ^PD are Control Page Up and Control Page Down ^HO and ^EN are Control Home and Control End - and = are Alt - and Alt = Many of the above keys are standard editing functions, and will be of no practical use as macro names, but they are included just in case. To specify a macro, you need to use the following layout: NAME: Macro Text Line 1 Macro Text Line 2 . . Macro Text Line N :NAME The Tilde (~) has special meaning when it appears at the beginning or end of a line. When it appears at the beginning of a line, it serves as a place holder and is ignored when the macro is executed. This is very helpful if you want your macro to end with a "slash" command. For example, say you wanted to make an F2 macro that saved your message. If you simply Typed "F2: [ENTER] /ES [ENTER]", it would save the Macros file (assuming you - 4 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) are using WWIVEdit to edit the macros file). On the other hand, this macro would do what you want: F2: ~/ES :F2 When a tilde appears at the end of a line, it means that no carriage return should be sent during macro execution. This is useful if you don't want a new line to be started after the macro is done executing. Extending the above macro's second line to ~/ES~ would make it so that you would have to hit ENTER after pressing F2 to save the file, in case you accidently hit F2. Also, there is no reason why you can't have colors or even use the ^N keys (assuming that you are editing MACROS.LCL with WWIVEdit). You can even insert control characters, such as ESC by first hitting ^Q, and then hitting ESC.... CHAT MODE --------- WWIVEdit supports a two-way color chat that looks very similar to the Two-Way chat mode in WWIV 4.xx. You can enter chat mode by pressing both shift keys at the same time (or whatever you define it as in the .DEF file.) The chat mode is so similar to the BBS chat mode that most of my users didn't notice the difference until I pointed it out to them. There is only one known problem with the Two-Way chat mode in WWIVEdit. If the user should happen to hang up/get disconnected while in chat mode, the BBS will lock-up the next time a key is pressed on the keyboard. This shouldn't be a problem because the only way to get into chat mode is for the sysop to be there, and if the user hangs up in chat mode, the sysop will be there to reset the BBS (and computer). There will be no ill effects if the user should hang up during normal message entering because all keyboard I/O is done through normal BBS means. TAG LINES --------- WWIVEdit supports two kinds of tag lines. Personal Tag Lines, and BBS Tag Lines. Both are optional. Personal Tag Lines are defined by the user, and are appended to every message that the user posts unless he saves it with /SY or /ESY, or they disable taglines for a particular message, or you have set up NOTAG files. Taglines are fairly self explanatory to the user. The only thing that the sysop needs to know is that, at his option, NO USER can have tag lines. To invoke this power edit the DEFAULT.DEF file and set TAGLINES to 1. BBS Tag lines are definable by the Sysop. To create BBS Tag Line(s), create a file called BBS*.TAG. The * can be anything you want, and you can create as many of these files as you want. If more than one of them exists, WWIVEdit will select one at Random and append it to the message. If at some time you wish to disable these tag lines - 5 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) without deleting the files, you can change the BBSTAG setting in the DEFAULT.DEF file to 1. A new feature in WWIVEdit 2.2 is the ability to disable Tag Lines on selected message bases. Edit the file in your WWIVEDIT directory called NOTAG. The default file that comes with WWIVEdit contains only the symbol #. What this does is disable Tag Lines on Non-Networked personal E-Mail. Here is how NOTAG works. WWIVEdit will check each line in the NOTAG file to see if it is a "substring" of the DEST: line. Whenever personal E-Mail is sent on a system the Dest: line will appear as "User Name #10" or whatever. In this case, the "#" in the NOTAG file matches the "#" in the "#10". You are not limited to symbols though. You can just as easily type in a full message base name (these are CASE SENSITIVE). For Example, if you have a word association base and you don't want Tag lines in it, your NOTAG file would look like this: ----- # Word Association ----- If you have not installed the EDITINFO.MOD, then at times, the DEST: line will be non-descript. When WWIVEdit can't tell where a message is going, it will simply say "Message Base". You can add this line to your NOTAG file if you are subscribed to a Sub that doesn't allow Tag Lines because if you don't, when someone uses "W" or "P" to post a message, its going to get a tag line attached to it. DISCLAIMER ---------- WWIVEdit is a name that I arbitrarily choose in the process of writing this program. If there is any other editor out there that uses this name, it is unknown to me. WWIVEdit is the product of the work of Adam Caldwell. All routines used in this program were either written by Adam Caldwell, or directly modified to suit the purposes of this program with the following exceptions: EXECSWAP unit by TurboPower software The Author of this program is not responsible for any damages, frustrations, or other things that may result from the use of this program, nor does he guarantee that it will work on any system but his own. This program is provided As-Is. The Author will make modifications specifically requested by people who donate money, and may even do it for people who have not donated money, however, the Author does not guarantee this. - 6 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) PLEA FOR MONEY! --------------- WWIVEdit is distributed on a BegWare basis (I beg you to send me money!). If you find this program useful, PLEASE send me some money. If you send me $10 or more and create an account for me on your BBS (or your BBS is Snarfable), the newest version (or next version) will be uploaded to your BBS for free, provided you follow the directions given below. 1) Create an account with the name "THE EMPORER" (must be spelled EXACTLY like that), with a password of your choice, and a phone number ending in "2041" (or state that the BBS is Snarfable). 2) Send me the BBS's phone number... Otherwise, I don't know who to call! 3) You must have a HST or V.32 modem running at 9600+ If you don't have a high speed modem, then I will send you future version on diskette. This program may be freely distributed, so long as no fee is charged for it. All future version of this program will be distributed in a BegWare fashion. My BBS phone number is (614) 593-7836. I don't gaurantee that it will always be in service, but barring unforeseen hardships, it will be in service until June 1993. I can be contacted at: Adam Caldwell (Preferred till June 1993) 114 Grosvenor St Athens, Ohio 45701 OR Adam Caldwell 16952 Nash Rd Middlefield, Oh 44062 If you have internet, you can E-Mail me at any of the following: acaldwel@oucsace.cs.ohiou.edu acaldwel@bigbird.cs.ohiou.edu Note: I can't respond to UUCP mail because of our system setup. And finally, (the preffered method) via WWIV Net/Link 1 @16470 Link The First Galactic Empire (Link) 1 @6470 Net The First Galactic Empire (Net) 718 @5252 Net The Dragon's Den (Net) [If all else fails] Thank you for trying WWIVEdit The Emporer Sysop of "The First Galactic Empire" Tel: (614) 593-7836 (WWIV 4.21, WWIVLink node 16401 USR HST DS 16.8K) (614) 594-3051 (Voice) - 7 - WWIVEdit Version 2.3 By Adam Caldwell (1@16470 Link, 1@6470 Net) THANK YOU NOTES The Duelist - For Beta Testing my editor, getting me involved in WWIV, and helping me set up my board so long ago... Jim Wire - For help beyond the call of duty... Trader Jack - For the initial beta testing of WWIVEdit 2.3 Niloc - For his suggestions and beta testing of the editor on my system. Thanks also go to: Parapuke, Filo, Trojan, Ken, Aahz, Lance Halle, Raistlin, Blondie & The Warden, Phantom, Joe Hallahan, Gene Wells, and anyone everone who sent me suggestions and bug reports (and more importanly, money). WHAT'S NEW Version 2.3 ----------- - Added Configurable defaults - Added Configurable Key Bindings - Added Install program - Fixed a pesky bug that caused a blank to appear after the cursor if you backspace while the cursor was at the end of a line and there was no text after the current line (Gee, how many of you figured out that this one actually existed? :) - Fixed some range checking problems having to do with cursor movement - Another significant re-arangement of the source - Added several new functions such as delete word right, cursor to top of page, cursor to bottom of page, block write to file, and several others - Added a defaults section for the users - Major rewrite of the spell checker - More color changes - Added ability to select between pure DOS output and direct video writes - Added smooth local scrolling similar to FEdit - Added local mouse support - 8 -